Fixing the Footnotes and Feature Flag on the Function Contracts RFC#2754
Merged
JustusAdam merged 5 commits intomodel-checking:mainfrom Sep 12, 2023
Merged
Fixing the Footnotes and Feature Flag on the Function Contracts RFC#2754JustusAdam merged 5 commits intomodel-checking:mainfrom
JustusAdam merged 5 commits intomodel-checking:mainfrom
Conversation
JustusAdam
changed the title
JustusAdam
changed the title
Contributor
|
Can you link or add the screenshot for the rendered page after the change? |
jaisnan
approved these changes
Sep 12, 2023
Contributor
jaisnan
left a comment
jaisnan
left a comment
There was a problem hiding this comment.
Approving! If possible, could you add a link to rendered page after the change?
Contributor
Author
Is this what you were thinking of?
|
Contributor
Yes, thank you! Looks great! |
feliperodri
approved these changes
Sep 12, 2023
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of changes:
The function contracts RFC as rendered on the website has broken footnotes. The reason is that mdbooks renders markdown differently than GitHub (of course, why would the same syntax, for the same language exhibit the same behavior with two different compilers, that'd just be silly.). Instead of rendering all footnotes at the bottom they were interspersed with the text, breaking the reading flow. In addition the footnotes of mdbook do not support multiple paragraphs and code blocks so one of the footnotes required rephrasing.
Also fixes the incorrectly named
-Zcontractsfeature flagChecklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.